﻿#region License
// Copyright 2007-2008 Rory Plaire (codekaizen@gmail.com)
/*
 * This license governs use of the accompanying software. If you use the software, you
 * accept this license. If you do not accept the license, do not use the software.
 * 
 * 1. Definitions
 * The terms "reproduce," "reproduction," "derivative works," and "distribution" have the
 * same meaning here as under U.S. copyright law.
 * A "contribution" is the original software, or any additions or changes to the software.
 * A "contributor" is any person that distributes its contribution under this license.
 * "Licensed patents" are a contributor's patent claims that read directly on its contribution.
 * 
 * 2. Grant of Rights
 * (A) Copyright Grant- Subject to the terms of this license, including the license conditions 
 *     and limitations in section 3, each contributor grants you a non-exclusive, worldwide, 
 *     royalty-free copyright license to reproduce its contribution, prepare derivative works 
 *     of its contribution, and distribute its contribution or any derivative works that you create.
 * (B) Patent Grant- Subject to the terms of this license, including the license conditions and 
 *     limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free 
 *     license under its licensed patents to make, have made, use, sell, offer for sale, import, 
 *     and/or otherwise dispose of its contribution in the software or derivative works of the 
 *     contribution in the software.
 * 
 * 3. Conditions and Limitations
 * (A) No Trademark License- This license does not grant you rights to use any contributors' 
 *     name, logo, or trademarks.
 * (B) If you bring a patent claim against any contributor over patents that you claim are 
 *     infringed by the software, your patent license from such contributor to the software 
 *     ends automatically.
 * (C) If you distribute any portion of the software, you must retain all copyright, patent, 
 *     trademark, and attribution notices that are present in the software.
 * (D) If you distribute any portion of the software in source code form, you may do so only under 
 *     this license by including a complete copy of this license with your distribution. If you 
 *     distribute any portion of the software in compiled or object code form, you may only do so 
 *     under a license that complies with this license.
 * (E) The software is licensed "as-is." You bear the risk of using it. The contributors give no 
 *     express warranties, guarantees or conditions. You may have additional consumer rights under 
 *     your local laws which this license cannot change. To the extent permitted under your local laws, 
 *     the contributors exclude the implied warranties of merchantability, fitness for a particular 
 *     purpose and non-infringement.
 * 
 */
#endregion

using System;
using System.Collections.Generic;

namespace NPack.Interfaces
{
    ///<summary>
    /// Interface for matrix creation factories
    ///</summary>
    ///<typeparam name="TComponent">The type of the components</typeparam>
    ///<typeparam name="TMatrix">The type of the matrix</typeparam>
    public interface IMatrixFactory<TComponent, TMatrix>
        where TComponent : IEquatable<TComponent>, IComparable<TComponent>, 
                           IComputable<TComponent>, IConvertible, IFormattable
        where TMatrix : IMatrix<TComponent, TMatrix>, IEquatable<TMatrix>,
                        IComparable<TMatrix>,IComputable<TMatrix>
    {
        ///<summary>
        /// Function to create a <paramref name="rowCount"/>x<paramref name="columnCount"/> matrix.
        ///</summary>
        ///<param name="rowCount">The number of rows</param>
        ///<param name="columnCount">The number of columns</param>
        ///<returns>The created matrix</returns>
        TMatrix CreateMatrix(Int32 rowCount, Int32 columnCount);

        ///<summary>
        /// Function to create a <paramref name="rowCount"/>x<paramref name="columnCount"/> matrix. It is instantiated with the provided <paramref name="values"/>.
        ///</summary>
        ///<param name="rowCount">The number of rows</param>
        ///<param name="columnCount">The number of columns</param>
        ///<param name="values">The values for the matrix</param>
        ///<returns>The created matrix</returns>
        TMatrix CreateMatrix(Int32 rowCount, Int32 columnCount, IEnumerable<TComponent> values);

        ///<summary>
        /// Function to create a <paramref name="format"/>-<paramref name="rowCount"/>x<paramref name="columnCount"/> matrix.
        ///</summary>
        ///<param name="format">The matrix' format</param>
        ///<param name="rowCount">The number of rows</param>
        ///<param name="columnCount">The number of columns</param>
        ///<returns>The created matrix</returns>
        TMatrix CreateMatrix(MatrixFormat format, Int32 rowCount, Int32 columnCount);
        
        /// <summary>
        /// Creates a matrix that is a clone of <paramref name="matrix"/>
        /// </summary>
        /// <param name="matrix">The matrix to clone</param>
        /// <returns>The created matrix</returns>
        TMatrix CreateMatrix(TMatrix matrix);
        //TMatrix CreateMatrix(IMatrix<TComponent> matrix);
    }
}
